public class GxColumnDefinition
The class holds the common props between column and column groups. Every property and method has one or more tag attached.
The following is the meaning for each tag :
| Enterprise | The property/method is used only with the enterprise version. using it without having a valid license will be ignored. |
| Configuration | Properties and methods which are tagged with this tag are used to configure the grid before it is rendered on the client. Changing these properties or calling these methods won't affect the grid which is displayed on the client. In order to reflect your changes on the client, you need to re-render the whole grid or re-render the column definition once again. |
| API | Methods/properties tagged with this tag can be called before or after the grid is rendered on the client and they don't require a refresh. |
| ColumnsRenderer | Changing this property or calling this method after the first render require columns re-render using updateColumns() method |
| GridRenderer | Changing this property or calling this method after the first render require full re-render using render() method |
| Modifier and Type | Field and Description |
|---|---|
BBjString | ColumnGroupShow!Whether to show the column when the group is open / closed.
|
ArrayList | HeaderClass!CSS class(es) to use for the header cell.
|
BBjString | HeaderTooltip!Tooltip for the column header
|
BBjString | Label!The name to render in the column header.
|
BBjNumber | SuppressFiltersToolPanel!Set to true if you do not want this column (filter) or group (filter group) to appear in the Filters Tool Panel.
|
BBjNumber | SuppressToolPanel!Set to true if you do not want this column or group to appear in the tool panel.
|
ArrayList | ToolPanelClass!CSS class(es) to use for the tool panel cell.
|
| Modifier and Type | Method and Description |
|---|---|
static BBjString | COLUMN_GROUP_CLOSED()A constant which defines the group state as opened |
static BBjString | COLUMN_GROUP_OPENED()A constant which defines the group state as opened |
JsonObject | getAsJsonObject()Convert the definition to Json Object |
public BBjString ColumnGroupShow!Whether to show the column when the group is open / closed.
#Configuration
#ColumnsRenderer
COLUMN_GROUP_CLOSED() COLUMN_GROUP_OPENED()public ArrayList HeaderClass!CSS class(es) to use for the header cell.
#Configuration
#ColumnsRenderer
public BBjString HeaderTooltip!Tooltip for the column header
#Configuration
#ColumnsRenderer
public BBjString Label!The name to render in the column header.
#Configuration
#ColumnsRenderer
public BBjNumber SuppressFiltersToolPanel!Set to true if you do not want this column (filter) or group (filter group) to appear in the Filters Tool Panel.
#Configuration
#ColumnsRenderer
public BBjNumber SuppressToolPanel!Set to true if you do not want this column or group to appear in the tool panel.
#Configuration
#ColumnsRenderer
public ArrayList ToolPanelClass!CSS class(es) to use for the tool panel cell.
#Configuration
#ColumnsRenderer
public static BBjString COLUMN_GROUP_CLOSED()A constant which defines the group state as opened
public static BBjString COLUMN_GROUP_OPENED()A constant which defines the group state as opened
public JsonObject getAsJsonObject()Convert the definition to Json Object